001: /*
002: * ==============================================================================
003: * Licensed under the Apache License, Version 2.0 (the "License"); you may not
004: * use this file except in compliance with the License. You may obtain a copy of
005: * the License at
006: *
007: * http://www.apache.org/licenses/LICENSE-2.0
008: *
009: * Unless required by applicable law or agreed to in writing, software
010: * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
011: * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
012: * License for the specific language governing permissions and limitations under
013: * the License.
014: */
015: package wicket.jmx;
016:
017: import wicket.settings.IMarkupSettings;
018:
019: /**
020: * Markup settings.
021: *
022: * @author eelcohillenius
023: */
024: public interface MarkupSettingsMBean {
025: /**
026: * If true, automatic link resolution is enabled. Disabled by default.
027: *
028: * @see wicket.markup.resolver.AutoLinkResolver
029: * @see wicket.markup.parser.filter.WicketLinkTagHandler
030: * @return Returns the automaticLinking.
031: */
032: boolean getAutomaticLinking();
033:
034: /**
035: * @return Returns the compressWhitespace.
036: * @see IMarkupSettings#setCompressWhitespace(boolean)
037: */
038: boolean getCompressWhitespace();
039:
040: /**
041: * @return Returns the defaultAfterDisabledLink.
042: */
043: String getDefaultAfterDisabledLink();
044:
045: /**
046: * @return Returns the defaultBeforeDisabledLink.
047: */
048: String getDefaultBeforeDisabledLink();
049:
050: /**
051: * @since 1.1
052: * @return Returns default encoding of markup files. If null, the operating
053: * system provided encoding will be used.
054: */
055: String getDefaultMarkupEncoding();
056:
057: /**
058: * @return markup parser factory
059: */
060: String getMarkupParserFactory();
061:
062: /**
063: * @return Returns the stripComments.
064: * @see IMarkupSettings#setStripComments(boolean)
065: */
066: boolean getStripComments();
067:
068: /**
069: * Gets whether to remove wicket tags from the output.
070: *
071: * @return whether to remove wicket tags from the output
072: */
073: boolean getStripWicketTags();
074:
075: /**
076: * @return if true, xml declaration will be removed.
077: */
078: boolean getStripXmlDeclarationFromOutput();
079:
080: /**
081: * Application default for automatic link resolution. Please
082: *
083: * @see wicket.markup.resolver.AutoLinkResolver and
084: * @see wicket.markup.parser.filter.WicketLinkTagHandler for more details.
085: *
086: * @param automaticLinking
087: * The automaticLinking to set.
088: */
089: void setAutomaticLinking(boolean automaticLinking);
090:
091: /**
092: * Turns on whitespace compression. Multiple occurrences of space/tab
093: * characters will be compressed to a single space. Multiple line breaks
094: * newline/carriage-return will also be compressed to a single newline.
095: * <p>
096: * Compression is currently not HTML aware and so it may be possible for
097: * whitespace compression to break pages. For this reason, whitespace
098: * compression is off by default and you should test your application
099: * throroughly after turning whitespace compression on.
100: * <p>
101: * Spaces are removed from markup at markup load time and there should be no
102: * effect on page rendering speed. In fact, your pages should render faster
103: * with whitespace compression enabled.
104: *
105: * @param compressWhitespace
106: * The compressWhitespace to set.
107: */
108: void setCompressWhitespace(final boolean compressWhitespace);
109:
110: /**
111: * @param defaultAfterDisabledLink
112: * The defaultAfterDisabledLink to set.
113: */
114: void setDefaultAfterDisabledLink(String defaultAfterDisabledLink);
115:
116: /**
117: * @param defaultBeforeDisabledLink
118: * The defaultBeforeDisabledLink to set.
119: */
120: void setDefaultBeforeDisabledLink(String defaultBeforeDisabledLink);
121:
122: /**
123: * Set default encoding for markup files. If null, the encoding provided by
124: * the operating system will be used.
125: *
126: * @param encoding
127: */
128: void setDefaultMarkupEncoding(final String encoding);
129:
130: /**
131: * Enables stripping of markup comments denoted in markup by HTML comment
132: * tagging.
133: *
134: * @param stripComments
135: * True to strip markup comments from rendered pages
136: */
137: void setStripComments(boolean stripComments);
138:
139: /**
140: * Sets whether to remove wicket tags from the output.
141: *
142: * @param stripWicketTags
143: * whether to remove wicket tags from the output
144: */
145: void setStripWicketTags(boolean stripWicketTags);
146:
147: /**
148: * @param strip
149: * if true, xml declaration will be stripped from output
150: */
151: void setStripXmlDeclarationFromOutput(final boolean strip);
152: }
|